<html lang="en-US">

<head>
    
<title>Go1.16 新特性：快速上手 Go embed - 花落雨忧</title>

<meta property="og:title" content="Go1.16 新特性：快速上手 Go embed - 花落雨忧">



    



    
    <meta property="description" content="在以前，很多从其他语言转过来 Go 语言的同学会问到，或是踩到一个坑。就是以为 Go 语言所打包的二进制文件中会包含配置文件的联同编译和打包。
结果往往一把二进制文件挪来挪去，就无法把应用程序运行起来了。因为无法读取到静态文件的资源。
无法将静态资源编译打包进二进制文件的话，通常会有两种解决方法：
[&amp;hellip;] 第二种情况的话，Go 以前是不支持的，大家就会去借助各种花式的开源库，例 &amp;hellip;">
    <meta property="og:description" content="在以前，很多从其他语言转过来 Go 语言的同学会问到，或是踩到一个坑。就是以为 Go 语言所打包的二进制文件中会包含配置文件的联同编译和打包。
结果往往一把二进制文件挪来挪去，就无法把应用程序运行起来了。因为无法读取到静态文件的资源。
无法将静态资源编译打包进二进制文件的话，通常会有两种解决方法：
[&amp;hellip;] 第二种情况的话，Go 以前是不支持的，大家就会去借助各种花式的开源库，例 &amp;hellip;">
    






<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1">

<link rel="shortcut icon" href="https://www.lican.asia/logo/logo.png" type="image/x-icon" />



<link rel="stylesheet" href="/css/style.min.css" />

<link rel="stylesheet" href="/css/reset.min.css" />




<script src="https://www.lican.asia/js/highlight.min.js"></script>

<script>
hljs.configure({ ignoreUnescapedHTML: true })
hljs.highlightAll();
</script>


<script src="https://www.lican.asia/js/jquery.min.js"></script>




<link href="https://www.lican.asia/css/hugo-code.min.css" rel="stylesheet" />



    <style>
        .post-content img {
            max-width: 400px;
        }
    </style>
</head>

<body id="period" class="home blog">
    <a class="skip-content" href="#main">Press "Enter" to skip to content</a>
    <div id="overflow-container" class="overflow-container">
        <header class="site-header" id="site-header" role="banner">
    <div class="max-width">
        <div id="title-container" class="title-container">
            <div id="site-title" class="site-title"><a href="/">花落雨忧</a></div>
            <p class="tagline">思所及 力所行 方为真.</p>
        </div>
        
        <div id="menu-primary-container" class="menu-primary-container">
            <div class="icon-container">
            </div>
            <div id="menu-primary" class="menu-container menu-primary" role="navigation">
                <nav class="menu">
                    <ul id="menu-primary-items" class="menu-primary-items">
                        
                        
                        <li id="menu-item-0"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/posts" aria-current="page" tabindex="0">首页</a></li>
                        
                        <li id="menu-item-1"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/tech/" aria-current="page" tabindex="1">技术文档</a></li>
                        
                        <li id="menu-item-2"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/article/" aria-current="page" tabindex="2">文章</a></li>
                        
                        <li id="menu-item-3"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/project/" aria-current="page" tabindex="3">项目</a></li>
                        
                        <li id="menu-item-4"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/about/" aria-current="page" tabindex="4">关于</a></li>
                        
                    </ul>
                </nav>
            </div>
        </div>
    </div>
</header>

        <div id="primary-container" class="primary-container">
            <div class="max-width">
                <section id="main" class="main" role="main">
                    <div id="loop-container" class="loop-container">
                        <div
                            class="post type-post status-publish format-standard hentry entry">
                            <article>
                                <div class="post-container">
                                    <div class="post-header">
                                        <h2 class="post-title">
                                            <a href="/posts/posts/go/go1.16-2/">Go1.16 新特性：快速上手 Go embed</a>
                                        </h2>
                                        
                                        <div class="post-byline">Published on
                                            <a class="date" href="javascript:;">2021/02/11</a>
                                            
                                            
                                            
                                            
                                            
                                        
                                    </div>
                                    <div class="post-content">
                                        <p>在以前，很多从其他语言转过来 Go 语言的同学会问到，或是踩到一个坑。就是以为 Go 语言所打包的二进制文件中会包含配置文件的联同编译和打包。</p>
<p><img src="https://imgkr2.cn-bj.ufileos.com/f59a06c7-2fa1-41f4-901c-990f7dd7d715.png?UCloudPublicKey=TOKEN_8d8b72be-579a-4e83-bfd0-5f6ce1546f13&amp;Signature=werBc5OkLhKUh0JhpYpcAtl3etA%253D&amp;Expires=1612147306" alt=""></p>
<p>结果往往一把二进制文件挪来挪去，就无法把应用程序运行起来了。因为无法读取到静态文件的资源。</p>
<p>无法将静态资源编译打包进二进制文件的话，通常会有两种解决方法：</p>
<ul>
<li>第一种是识别这类静态资源，是否需要跟着程序走。</li>
<li>第二种就是考虑将其打包进二进制文件中。</li>
</ul>
<p>第二种情况的话，Go 以前是不支持的，大家就会去借助各种花式的开源库，例如：go-bindata/go-bindata 来实现。</p>
<p>但从在 Go1.16 起，Go 语言自身正式支持了该项特性，今天我们将通过这篇文章快速了解和学习这项特性。</p>
<h2 id="基本使用">基本使用</h2>
<p>演示代码：</p>
<pre tabindex="0"><code>import _ &#34;embed&#34;

//go:embed hello.txt
var s string

func main() {
	print(s)
}
</code></pre><p>我们首先在对应的目录下创建了 <code>hello.txt</code> 文件，并且写入文本内容 “吃煎鱼”。</p>
<p>在代码中编写了最为核心的 <code>//go:embed hello.txt</code> 注解。注解的格式很简单，就是 <code>go:embed</code> 指令声明，外加读取的内容的地址，可支持相对和绝对路径。</p>
<p>输出结果：</p>
<pre tabindex="0"><code>吃煎鱼
</code></pre><p>读取到静态文件中的内容后自动赋值给了变量 <code>s</code>，并且在主函数中成功输出。</p>
<p>而针对其他的基础类型，Go embed 也是支持的：</p>
<pre tabindex="0"><code>//go:embed hello.txt
var s string

//go:embed hello.txt
var b []byte

//go:embed hello.txt
var f embed.FS

func main() {
	print(s)
	print(string(b))

	data, _ := f.ReadFile(&#34;hello.txt&#34;)
	print(string(data))
}
</code></pre><p>输出结果：</p>
<pre tabindex="0"><code>吃煎鱼
吃煎鱼
吃煎鱼
</code></pre><p>我们同时在一个代码文件中进行了多个 embed 的注解声明。</p>
<p>并且针对 string、slice、byte、fs 等多种类型进行了打包，也不需要过多的处理，非常便利。</p>
<h2 id="拓展用法">拓展用法</h2>
<p>除去基本用法完，embed 本身在指令上也支持多种变形：</p>
<pre tabindex="0"><code>//go:embed hello1.txt hello2.txt
var f embed.FS

func main() {
	data1, _ := f.ReadFile(&#34;hello1.txt&#34;)
	fmt.Println(string(data1))

	data2, _ := f.ReadFile(&#34;hello2.txt&#34;)
	fmt.Println(string(data2))
}
</code></pre><p>在指定 <code>go:embed</code> 注解时可以一次性多个文件来读取，并且也可以一个变量多行注解：</p>
<pre tabindex="0"><code>//go:embed hello1.txt 
//go:embed hello2.txt
var f embed.FS
</code></pre><p>也可以通过在注解中指定目录 <code>helloworld</code>，再对应读取文件：</p>
<pre tabindex="0"><code>//go:embed helloworld
var f embed.FS

func main() {
	data1, _ := f.ReadFile(&#34;helloworld/hello1.txt&#34;)
	fmt.Println(string(data1))

	data2, _ := f.ReadFile(&#34;helloworld/hello2.txt&#34;)
	fmt.Println(string(data2))
}
</code></pre><p>同时既然能够支持目录读取，也能支持贪婪模式的匹配：</p>
<pre tabindex="0"><code>//go:embed helloworld/*
var f embed.FS
</code></pre><p>可能会有小伙伴注意到，<code>embed.FS</code> 也能调各类文件系统的接口，其实本质是 <code>embed.FS</code> 实现了 <code>io/fs</code> 接口。</p>
<h2 id="只读属性">只读属性</h2>
<p>在 embed 所提供的 FS 中，我们可以发现其都是打开和只读方法：</p>
<pre tabindex="0"><code>type FS
    func (f FS) Open(name string) (fs.File, error)
    func (f FS) ReadDir(name string) ([]fs.DirEntry, error)
    func (f FS) ReadFile(name string) ([]byte, error)
</code></pre><p>根据此也可以确定 embed 所打包进二进制文件的内容只允许读取，不允许变更。</p>
<p>更抽象来讲就是在编译期就确定了 embed 的内容，在运行时不允许修改，保证了一致性。</p>
<h2 id="总结">总结</h2>
<p>通过 Go1.16 正式提供的 embed 特性，可以实现原生就支持静态资源文件的嵌入。整体如下：</p>
<ul>
<li>在功能上：能够将静态资源嵌入二进制文件中，在运行时可以打开和读取相关的打包后的静态文件。</li>
<li>在安全上：是在编译期编译嵌入，在运行时不支持修改。</li>
<li>在使用上：
<ul>
<li>支持单文件读取：<code>go:embed hello.txt</code>。</li>
<li>支持多文件读取：<code>go:embed hello1.txt</code>、<code>go:embed hello2.txt</code>。</li>
<li>支持目录读取：<code>go:embed helloworld</code>。</li>
<li>支持贪婪匹配：<code>go:embed helloworld/*</code>。</li>
</ul>
</li>
</ul>
<p>总的来讲，Go1.16 embed 特性很好的填补了 Go 语言在打包静态文件资源的一块原生空白领域。同时也说明了 Go 官方的确在不断地吸收社区的一些良好的想法和经验。</p>


                                        
                                        
                                        
                                        <div class="rp4wp-related-posts">
                                            <h3>相关文章</h3>
                                            <ul>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.asia/posts/posts/go/go1.16-1/">Go1.16 即将正式发布，以下变更你需要知道</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.asia/posts/posts/go/go-error2panic/">Go 错误处理：用 panic 取代 err != nil 的模式</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.asia/posts/posts/go/go-concurrent-lock/">Go 并发：一些有趣的现象和要避开的 “坑”</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.asia/posts/posts/go/go2-errors/">先睹为快，Go2 Error 的挣扎之路</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.asia/posts/posts/go/gophercon2020-errors/">重磅：Go errors 将不会有任何进一步的改进计划</a>
                                                    </div>
                                                </li>
                                                
                                            </ul>
                                        </div>
                                        
                                        
                                    </div>

                                    
                                    
                                    

                                    
                                    <div class="post-meta">
                                        
                                        
                                        <div class="post-tags">
                                            <ul>
                                            
                                            <li>
                                                <a href="/tags/go" title="View all posts tagged match">go</a>
                                            </li>
                                            
                                            </ul>
                                        </div>
                                        
                                        
                                        <nav class="further-reading">
                                            
                                            <div class="previous">
                                                <span>&lt;&lt; Prev</span>
                                                <a href="https://www.lican.asia/posts/posts/go/go1.16-1/"
                                                    rel="prev">Go1.16 即将正式发布，以下变更你需要知道</a> </div>
                                            
                                            
                                            <div class="next">
                                                <span>Next >></span>
                                                <a href="https://www.lican.asia/posts/posts/go/go1.16-3/">Go1.16 新特性：详解内存管理机制的变更，你需要了解</a> 
                                            </div>
                                            
                                        </nav>
                                    </div>
                                    
                                    

                                    
                                    
                                    

                                </div>
                            </article>
                        </div>
                    </div>
                </section>
                <aside class="sidebar sidebar-primary" id="sidebar-primary" role="complementary">
    <h1 class="screen-reader-text">Sidebar</h1>
    

    
    
    <section id="text-2" class="widget widget_text">
        <div class="textwidget">
            
            <div id="profile">
                <div id="profile_picture"><img src="https://www.lican.asia/logo/logo.png"></div>
                <div id="profile_intro">
                    <p><span class="name">Lican</span></p>
                    <p class="intro">全栈开发者，爱好造轮子。</p>
                </div>
            </div>
            
            <p>
                <script type="text/javascript">
                    (function ($) {
                        $(document).ready(function () {
                            var menuPrimaryContainer = $('#menu-primary-container');
                            var profile = $('#text-2');
                            $('#toggle-navigation').click(function () {
                                if (menuPrimaryContainer.hasClass('open')) {
                                    profile.removeClass('open');
                                } else {
                                    profile.addClass('open');
                                }
                            });
                        });
                    })(jQuery);
                </script>
            </p>
        </div>
    </section>
    
    
    
    
    
    <section id="text-5" class="widget widget_text">
        <h2 class="widget-title">开源项目</h2>
        <div class="textwidget">
            <div id="projects" style="line-height: 22px;">
                
                <a href="https://github.com/idoubi/gonews"
                    target="_blank">gonews</a>: &nbsp;Daily news for golang<br>
                
                <a href="https://github.com/idoubi/sql2struct"
                    target="_blank">sql2struct</a>: &nbsp;Generate go struct according to SQL<br>
                
                <a href="https://github.com/idoubi/goz"
                    target="_blank">goz</a>: &nbsp;Request library used in golang<br>
                
        </div>
    </section>
    
    

    
    
    
    
    <section id="qrcode" class="widget widget_media_image">
        <h2 class="widget-title">微信公众号</h2>
        <img width="258" height="258"
            src="https://www.lican.asia/wechat/lican.png"
            class="image wp-image-5514  attachment-full size-full" alt=""
            style="max-width: 100%; height: auto;"
            sizes="(max-width: 258px) 100vw, 258px">
    </section>
    
    

    
    
    

    
    
    

    
    
    
    
</aside>
            </div>
        </div>

        <footer id="site-footer" class="site-footer" role="contentinfo">
    <div class="max-width">
    </div>
    <div class="footer">
        <div id="footercontent">
            © lican.asia All rights reserved<br/>
            Built with Hugo Theme <a href="https://github.com/idoubi/hugo-theme-period" target="_blank">Period</a>
        </div>
    </div>
</footer>

<script>
    var _hmt = _hmt || [];
    (function() {
      var hm = document.createElement("script");
      hm.src = "https://hm.baidu.com/hm.js?e8351b6d4626d5881d439ea1f6184baa";
      var s = document.getElementsByTagName("script")[0]; 
      s.parentNode.insertBefore(hm, s);
    })();
</script>
    
    
    </div>
    
</body>

</html>